org.springframework.orm.hibernate3.annotation

Class AnnotationSessionFactoryBean

java.lang.Object

org.springframework.orm.hibernate3.HibernateExceptionTranslator

org.springframework.orm.hibernate3.AbstractSessionFactoryBean

org.springframework.orm.hibernate3.LocalSessionFactoryBean

org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean

All Implemented Interfaces:

Aware, BeanClassLoaderAware, DisposableBean, FactoryBean<SessionFactory>, InitializingBean, ResourceLoaderAware, PersistenceExceptionTranslator

public class AnnotationSessionFactoryBean
extends LocalSessionFactoryBean
implements ResourceLoaderAware

Subclass of Spring's standard LocalSessionFactoryBean for Hibernate, supporting JDK 1.5+ annotation metadata for mappings.

Note: This class requires Hibernate 3.2 or later, with the Java Persistence API and the Hibernate Annotations add-on present.

Example for an AnnotationSessionFactoryBean bean definition:

 <bean id="sessionFactory" class="org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean">
   <property name="dataSource" ref="dataSource"/>
   <property name="annotatedClasses">
     <list>
       <value>test.package.Foo</value>
       <value>test.package.Bar</value>
     </list>
   </property>
 </bean>

Or when using classpath scanning for autodetection of entity classes:

 <bean id="sessionFactory" class="org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean">
   <property name="dataSource" ref="dataSource"/>
   <property name="packagesToScan" value="test.package"/>
 </bean>

Since:

1.2.2

Author:

Juergen Hoeller

See Also:

AbstractSessionFactoryBean.setDataSource(javax.sql.DataSource), LocalSessionFactoryBean.setHibernateProperties(java.util.Properties), setAnnotatedClasses(java.lang.Class[]), setAnnotatedPackages(java.lang.String[])

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Class[]	annotatedClasses
private java.lang.String[]	annotatedPackages
private TypeFilter[]	entityTypeFilters
private static java.lang.String	PACKAGE_INFO_SUFFIX
private java.lang.String[]	packagesToScan
private static java.lang.String	RESOURCE_PATTERN
private ResourcePatternResolver	resourcePatternResolver

Fields inherited from class org.springframework.orm.hibernate3.AbstractSessionFactoryBean

logger

Constructor Summary

Constructors

Constructor and Description
AnnotationSessionFactoryBean()

Method Summary

Methods

Modifier and Type	Method and Description
private boolean	matchesEntityTypeFilter(MetadataReader reader, MetadataReaderFactory readerFactory) Check whether any of the configured entity type filters matches the current class descriptor contained in the metadata reader.
protected void	postProcessAnnotationConfiguration(AnnotationConfiguration config) To be implemented by subclasses which want to to perform custom post-processing of the AnnotationConfiguration object after this FactoryBean performed its default initialization.
protected void	postProcessConfiguration(Configuration config) This default implementation delegates to postProcessAnnotationConfiguration(AnnotationConfiguration).
protected void	postProcessMappings(Configuration config) Reads metadata from annotated classes and packages into the AnnotationConfiguration instance.
protected void	scanPackages(AnnotationConfiguration config) Perform Spring-based scanning for entity classes.
void	setAnnotatedClasses(java.lang.Class[] annotatedClasses) Specify annotated classes, for which mappings will be read from class-level JDK 1.5+ annotation metadata.
void	setAnnotatedPackages(java.lang.String[] annotatedPackages) Specify the names of annotated packages, for which package-level JDK 1.5+ annotation metadata will be read.
void	setConfigurationClass(java.lang.Class<?> configurationClass) Specify the Hibernate Configuration class to use.
void	setEntityTypeFilters(TypeFilter[] entityTypeFilters) Specify custom type filters for Spring-based scanning for entity classes.
void	setPackagesToScan(java.lang.String[] packagesToScan) Specify packages to search using Spring-based scanning for entity classes in the classpath.
void	setResourceLoader(ResourceLoader resourceLoader) Set the ResourceLoader that this object runs in.

Methods inherited from class org.springframework.orm.hibernate3.LocalSessionFactoryBean

afterSessionFactoryCreation, buildSessionFactory, createDatabaseSchema, destroy, dropDatabaseSchema, executeSchemaScript, executeSchemaStatement, getConfigTimeCacheProvider, getConfigTimeDataSource, getConfigTimeLobHandler, getConfigTimeTransactionManager, getConfiguration, getHibernateProperties, newConfiguration, newSessionFactory, setBeanClassLoader, setCacheableMappingLocations, setCacheProvider, setCacheRegionFactory, setCollectionCacheStrategies, setConfigLocation, setConfigLocations, setEntityCacheStrategies, setEntityInterceptor, setEventListeners, setFilterDefinitions, setHibernateProperties, setJtaTransactionManager, setLobHandler, setMappingDirectoryLocations, setMappingJarLocations, setMappingLocations, setMappingResources, setNamingStrategy, setSchemaUpdate, setTypeDefinitions, updateDatabaseSchema, validateDatabaseSchema

Methods inherited from class org.springframework.orm.hibernate3.AbstractSessionFactoryBean

afterPropertiesSet, beforeSessionFactoryDestruction, getDataSource, getObject, getObjectType, getSessionFactory, isExposeTransactionAwareSessionFactory, isSingleton, isUseTransactionAwareDataSource, setDataSource, setExposeTransactionAwareSessionFactory, setUseTransactionAwareDataSource, wrapSessionFactoryIfNecessary

Methods inherited from class org.springframework.orm.hibernate3.HibernateExceptionTranslator

convertHibernateAccessException, setJdbcExceptionTranslator, translateExceptionIfPossible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESOURCE_PATTERN

private static final java.lang.String RESOURCE_PATTERN

See Also:

Constant Field Values

PACKAGE_INFO_SUFFIX

private static final java.lang.String PACKAGE_INFO_SUFFIX

See Also:

Constant Field Values

annotatedClasses

private java.lang.Class[] annotatedClasses

annotatedPackages

private java.lang.String[] annotatedPackages

packagesToScan

private java.lang.String[] packagesToScan

entityTypeFilters

private TypeFilter[] entityTypeFilters

resourcePatternResolver

private ResourcePatternResolver resourcePatternResolver

Constructor Detail

AnnotationSessionFactoryBean

public AnnotationSessionFactoryBean()

Method Detail

setConfigurationClass

public void setConfigurationClass(java.lang.Class<?> configurationClass)

Description copied from class: LocalSessionFactoryBean

Specify the Hibernate Configuration class to use. Default is "org.hibernate.cfg.Configuration"; any subclass of this default Hibernate Configuration class can be specified.

Can be set to "org.hibernate.cfg.AnnotationConfiguration" for using Hibernate3 annotation support (initially only available as alpha download separate from the main Hibernate3 distribution).

Annotated packages and annotated classes can be specified via the corresponding tags in "hibernate.cfg.xml" then, so this will usually be combined with a "configLocation" property that points at such a standard Hibernate configuration file.

Overrides:

setConfigurationClass in class LocalSessionFactoryBean

See Also:

LocalSessionFactoryBean.setConfigLocation(org.springframework.core.io.Resource), org.hibernate.cfg.Configuration, org.hibernate.cfg.AnnotationConfiguration

setAnnotatedClasses

public void setAnnotatedClasses(java.lang.Class[] annotatedClasses)

Specify annotated classes, for which mappings will be read from class-level JDK 1.5+ annotation metadata.

See Also:

org.hibernate.cfg.AnnotationConfiguration#addAnnotatedClass(Class)

setAnnotatedPackages

public void setAnnotatedPackages(java.lang.String[] annotatedPackages)

Specify the names of annotated packages, for which package-level JDK 1.5+ annotation metadata will be read.

See Also:

org.hibernate.cfg.AnnotationConfiguration#addPackage(String)

setPackagesToScan

public void setPackagesToScan(java.lang.String[] packagesToScan)

Specify packages to search using Spring-based scanning for entity classes in the classpath. This is an alternative to listing annotated classes explicitly.

Default is none. Specify packages to search for autodetection of your entity classes in the classpath. This is analogous to Spring's component-scan feature (ClassPathBeanDefinitionScanner).

setEntityTypeFilters

public void setEntityTypeFilters(TypeFilter[] entityTypeFilters)

Specify custom type filters for Spring-based scanning for entity classes.

Default is to search all specified packages for classes annotated with @javax.persistence.Entity, @javax.persistence.Embeddable or @javax.persistence.MappedSuperclass, as well as for Hibernate's special @org.hibernate.annotations.Entity.

See Also:

setPackagesToScan(java.lang.String[])

setResourceLoader

public void setResourceLoader(ResourceLoader resourceLoader)

Description copied from interface: ResourceLoaderAware

Set the ResourceLoader that this object runs in.

This might be a ResourcePatternResolver, which can be checked through instanceof ResourcePatternResolver. See also the ResourcePatternUtils.getResourcePatternResolver method.

Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked before ApplicationContextAware's setApplicationContext.

Specified by:

setResourceLoader in interface ResourceLoaderAware

Parameters:

resourceLoader - ResourceLoader object to be used by this object

See Also:

ResourcePatternResolver, ResourcePatternUtils.getResourcePatternResolver(org.springframework.core.io.ResourceLoader)

postProcessMappings

protected void postProcessMappings(Configuration config)
                            throws HibernateException

Reads metadata from annotated classes and packages into the AnnotationConfiguration instance.

Overrides:

postProcessMappings in class LocalSessionFactoryBean

Parameters:

config - the current Configuration object

Throws:

HibernateException - in case of Hibernate initialization errors

See Also:

org.hibernate.cfg.Configuration#buildMappings()

scanPackages

protected void scanPackages(AnnotationConfiguration config)

Perform Spring-based scanning for entity classes.

See Also:

setPackagesToScan(java.lang.String[])

matchesEntityTypeFilter

private boolean matchesEntityTypeFilter(MetadataReader reader,
                              MetadataReaderFactory readerFactory)
                                 throws java.io.IOException

Check whether any of the configured entity type filters matches the current class descriptor contained in the metadata reader.

Throws:

java.io.IOException

postProcessConfiguration

protected void postProcessConfiguration(Configuration config)
                                 throws HibernateException

This default implementation delegates to postProcessAnnotationConfiguration(AnnotationConfiguration).

Overrides:

postProcessConfiguration in class LocalSessionFactoryBean

Parameters:

config - the current Configuration object

Throws:

HibernateException - in case of Hibernate initialization errors

See Also:

org.hibernate.cfg.Configuration#buildMappings()

postProcessAnnotationConfiguration

protected void postProcessAnnotationConfiguration(AnnotationConfiguration config)
                                           throws HibernateException

To be implemented by subclasses which want to to perform custom post-processing of the AnnotationConfiguration object after this FactoryBean performed its default initialization.

Note: As of Hibernate 3.6, AnnotationConfiguration's features have been rolled into Configuration itself. Simply overriding #postProcessConfiguration(org.hibernate.cfg.Configuration) becomes an option as well then.

Parameters:

config - the current AnnotationConfiguration object

Throws:

HibernateException - in case of Hibernate initialization errors